home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / libblas / axpy.z / axpy
Encoding:
Text File  |  2002-10-03  |  3.6 KB  |  96 lines
  1. AXPY(3F)                                              Last changed: 11-2-98
  2.  
  3.  
  4. NNAAMMEE
  5.      SSAAXXPPYY, CCAAXXPPYY, DDAAXXPPYY, ZZAAXXPPYY - Adds a scalar multiple of a real or
  6.      complex vector to another real or complex vector
  7.  
  8. SSYYNNOOPPSSIISS
  9.      Real
  10.  
  11.         CCAALLLL SSAAXXPPYY ((_n,, _a_l_p_h_a,, _x,, _i_n_c_x,, _y,, _i_n_c_y))
  12.  
  13.      Double precision
  14.  
  15.         CCAALLLL DDAAXXPPYY ((_n,, _a_l_p_h_a,, _x,, _i_n_c_x,, _y,, _i_n_c_y))
  16.  
  17.      Complex
  18.  
  19.         CCAALLLL CCAAXXPPYY ((_n,, _a_l_p_h_a,, _x,, _i_n_c_x,, _y,, _i_n_c_y))
  20.  
  21.      Double complex
  22.  
  23.         CCAALLLL ZZAAXXPPYY ((_n,, _a_l_p_h_a,, _x,, _i_n_c_x,, _y,, _i_n_c_y))
  24.  
  25. IIMMPPLLEEMMEENNTTAATTIIOONN
  26.      IRIX systems
  27.  
  28. DDEESSCCRRIIPPTTIIOONN
  29.      SSAAXXPPYY/DDAAXXPPYY adds a scalar multiple of a real vector to another real
  30.      vector.
  31.  
  32.      CCAAXXPPYY/ZZAAXXPPYY adds a scalar multiple of a complex vector to another
  33.      complex vector.
  34.  
  35.      These routines perform the following vector operation:
  36.  
  37.           _y  <-  _a_l_p_h_a * _x + _y
  38.  
  39.      where _a_l_p_h_a is a real or complex scalar, and _x and _y are real or
  40.      complex vectors.
  41.  
  42.      These routines have the following arguments:
  43.  
  44.      _n         Integer.  (input)
  45.                Number of elements in the vectors.  If _n <= 0, these
  46.                routines return without any computation.
  47.  
  48.      _a_l_p_h_a     Scalar. (input)
  49.                SSAAXXPPYY: Real.
  50.                DDAAXXPPYY: Double precision.
  51.                CCAAXXPPYY: Complex.
  52.                ZZAAXXPPYY: Double complex.
  53.                If _a_l_p_h_a = 0 these routines return without any computation.
  54.  
  55.      _x         Array of dimension (_n-1) * |_i_n_c_x| + 1.  (input)
  56.                SSAAXXPPYY: Real array.
  57.                DDAAXXPPYY: Double precision array.
  58.                CCAAXXPPYY: Complex array.
  59.                ZZAAXXPPYY: Double complex array.
  60.                Contains the vector to be scaled before summation.
  61.  
  62.      _i_n_c_x      Integer.  (input)
  63.                Increment between elements of _x.  If _i_n_c_x = 0, the results
  64.                will be unpredictable.
  65.  
  66.      _y         Array of dimension (_n-1) * |_i_n_c_y| + 1.  (input and output)
  67.                SSAAXXPPYY: Real array.
  68.                DDAAXXPPYY: Double precision array.
  69.                CCAAXXPPYY: Complex array.
  70.                ZZAAXXPPYY: Double complex array.
  71.                Before calling the routine, _y contains the vector to be
  72.                summed.  After the routine ends, _y contains the result of
  73.                the summation.
  74.  
  75.      _i_n_c_y      Integer.  (input)
  76.                Increment between elements of _y.  If _i_n_c_y = 0, the results
  77.                will be unpredictable.
  78.  
  79. NNOOTTEESS
  80.      These routines are Level 1 Basic Linear Algebra Subprograms (Level 1
  81.      BLAS).
  82.  
  83.      When working backward (_i_n_c_x < 0 or _i_n_c_y < 0), each routine starts at
  84.      the end of the vector and moves backward, as follows:
  85.  
  86.           _x(1-_i_n_c_x * (_n-1)), _x(1-_i_n_c_x * (_n-2)), ..., _x(1)
  87.  
  88.           _y(1-_i_n_c_y * (_n-1)), _y(1-_i_n_c_y * (_n-2)), ..., _y(1)
  89.  
  90. RREETTUURRNN VVAALLUUEESS
  91.      When _n <= 0, real _a_l_p_h_a = 0., or complex _a_l_p_h_a = 0 = 0.+0._i, these
  92.      routines return immediately with no change in their arguments.
  93.  
  94. SSEEEE AALLSSOO
  95.      This man page is available only online.
  96.